<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: ipc::session::error Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceipc.html">ipc</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1session.html">session</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1session_1_1error.html">error</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle"><div class="title">ipc::session::error Namespace Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Namespace containing the <a class="el" href="namespaceipc_1_1session.html" title="Flow-IPC module providing the broad lifecycle and shared-resource organization – via the session conc...">ipc::session</a> module's extension of <a class="el" href="namespaceboost_1_1system.html" title="Small group of miscellaneous utilities to ease work with boost.system, joining its boost::system name...">boost.system</a> error conventions, so that that API can return codes/messages from within its own new set of error codes/messages.  
<a href="namespaceipc_1_1session_1_1error.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classipc_1_1session_1_1error_1_1Category.html">Category</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="namespaceboost_1_1system.html" title="Small group of miscellaneous utilities to ease work with boost.system, joining its boost::system name...">boost.system</a> category for errors returned by the <a class="el" href="namespaceipc_1_1session.html" title="Flow-IPC module providing the broad lifecycle and shared-resource organization – via the session conc...">ipc::session</a> module.  <a href="classipc_1_1session_1_1error_1_1Category.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a0708d4bec9ae853f4d7e3d7822fc8f2f"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2f">Code</a> { <br />
&#160;&#160;<a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fac416e988563e44bf15fc6a81743eef53">S_INVALID_ARGUMENT</a> = S_CODE_LOWEST_INT_VALUE
, <a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fafe29343445a7bf167cc186a44bd2c6ed">S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER</a>
, <a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa486f5607320d062fe89e559a1e7856b2">S_CLIENT_NAMESPACE_STORE_BAD_FORMAT</a>
, <a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa866090a4d042120126722b4daf1ecc33">S_CLIENT_MASTER_LOG_IN_RESPONSE_BAD</a>
, <br />
&#160;&#160;<a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2faa195e468548ba9602c27590f2d6d49f0">S_SERVER_MASTER_LOG_IN_REQUEST_CLIENT_APP_DISALLOWED_OR_UNKNOWN</a>
, <a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa3f305ed5a242f067c9116216c0674264">S_SERVER_MASTER_LOG_IN_REQUEST_CLIENT_APP_INCONSISTENT_CREDS</a>
, <a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa2c8c27c65ff6234220a84f96de8a1870">S_SESSION_OPEN_CHANNEL_REMOTE_PEER_REJECTED_PASSIVE_OPEN</a>
, <a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa10d32cf1382fb003f09a6df2da408574">S_SESSION_OPEN_CHANNEL_SERVER_CANNOT_PROCEED_RESOURCE_UNAVAILABLE</a>
, <br />
&#160;&#160;<a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa7d85b87223a9b277b8875c1f7971d6ad">S_SESSION_OPEN_CHANNEL_ACTIVE_TIMEOUT</a>
, <a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa7300721595cc25baa9a9e43bd76296aa">S_MUTEX_BIPC_MISC_LIBRARY_ERROR</a>
, <a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa8fe83fc1ea258698473af610c0023a9d">S_SERVER_MASTER_POST_LOG_IN_SEND_FAILED_MISC</a>
, <a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fac734bd48bbfe30867f627363a8d5afc4">S_SERVER_MASTER_LOG_IN_REQUEST_CONFIG_MISMATCH</a>
, <br />
&#160;&#160;<a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa5c437fa266aea0c8e2b348ee84dd61fa">S_RESOURCE_OWNER_UNEXPECTED</a>
, <a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa24eaed39f149e32f6ceaad54d24f8759">S_SESSION_FINISHED</a>
, <a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa6fba12db09e5bebfaa04f6372c41c2cf">S_END_SENTINEL</a>
<br />
 }</td></tr>
<tr class="memdesc:a0708d4bec9ae853f4d7e3d7822fc8f2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">All possible errors returned (via <code>Error_code</code> arguments) by <a class="el" href="namespaceipc_1_1session.html" title="Flow-IPC module providing the broad lifecycle and shared-resource organization – via the session conc...">ipc::session</a> functions/methods <em>outside of</em> <a class="el" href="namespaceipc_1_1transport.html" title="Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) betwe...">ipc::transport</a>-triggered errors involved in transport involved in doing session-related work; and possibly system-triggered errors.  <a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2f">More...</a><br /></td></tr>
<tr class="separator:a0708d4bec9ae853f4d7e3d7822fc8f2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9056f277d3ebf2778d06a2bb1f337c28"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1session_1_1error.html#a9056f277d3ebf2778d06a2bb1f337c28">make_error_code</a> (<a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2f">Code</a> err_code)</td></tr>
<tr class="memdesc:a9056f277d3ebf2778d06a2bb1f337c28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Analogous to <a class="el" href="namespaceipc_1_1transport_1_1error.html#aa825718d46992654588588b09a0f1be6" title="Given a Code enum value, creates a lightweight Error_code (a/k/a boost.system error_code) representin...">transport::error::make_error_code()</a>.  <a href="namespaceipc_1_1session_1_1error.html#a9056f277d3ebf2778d06a2bb1f337c28">More...</a><br /></td></tr>
<tr class="separator:a9056f277d3ebf2778d06a2bb1f337c28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad52f227f6cd73969ba6a898028264413"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1session_1_1error.html#ad52f227f6cd73969ba6a898028264413">operator&lt;&lt;</a> (std::ostream &amp;os, <a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2f">Code</a> val)</td></tr>
<tr class="memdesc:ad52f227f6cd73969ba6a898028264413"><td class="mdescLeft">&#160;</td><td class="mdescRight">Analogous to <a class="el" href="namespaceipc_1_1transport_1_1error.html#a4686a04e7ab89d4be42548cbb5b37975" title="Serializes a transport::error::Code to a standard output stream.">transport::error::operator&lt;&lt;()</a>.  <a href="namespaceipc_1_1session_1_1error.html#ad52f227f6cd73969ba6a898028264413">More...</a><br /></td></tr>
<tr class="separator:ad52f227f6cd73969ba6a898028264413"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6041e74db4e17a75d8eed2541dc026f6"><td class="memItemLeft" align="right" valign="top">std::istream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1session_1_1error.html#a6041e74db4e17a75d8eed2541dc026f6">operator&gt;&gt;</a> (std::istream &amp;is, <a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2f">Code</a> &amp;val)</td></tr>
<tr class="memdesc:a6041e74db4e17a75d8eed2541dc026f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Analogous to <a class="el" href="namespaceipc_1_1transport_1_1error.html#a64595c41a5810937c39733230628c499" title="Deserializes a transport::error::Code from a standard input stream.">transport::error::operator&gt;&gt;()</a>.  <a href="namespaceipc_1_1session_1_1error.html#a6041e74db4e17a75d8eed2541dc026f6">More...</a><br /></td></tr>
<tr class="separator:a6041e74db4e17a75d8eed2541dc026f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:aded1c40e8ae8a6ba0b9af47ab48a13bb"><td class="memItemLeft" align="right" valign="top">constexpr int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1session_1_1error.html#aded1c40e8ae8a6ba0b9af47ab48a13bb">S_CODE_LOWEST_INT_VALUE</a> = 1</td></tr>
<tr class="memdesc:aded1c40e8ae8a6ba0b9af47ab48a13bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Numeric value of the lowest Code.  <a href="namespaceipc_1_1session_1_1error.html#aded1c40e8ae8a6ba0b9af47ab48a13bb">More...</a><br /></td></tr>
<tr class="separator:aded1c40e8ae8a6ba0b9af47ab48a13bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Namespace containing the <a class="el" href="namespaceipc_1_1session.html" title="Flow-IPC module providing the broad lifecycle and shared-resource organization – via the session conc...">ipc::session</a> module's extension of <a class="el" href="namespaceboost_1_1system.html" title="Small group of miscellaneous utilities to ease work with boost.system, joining its boost::system name...">boost.system</a> error conventions, so that that API can return codes/messages from within its own new set of error codes/messages. </p>
<p >Historically this was written after <a class="el" href="namespaceipc_1_1transport_1_1error.html" title="Namespace containing the ipc::transport module&#39;s extension of boost.system error conventions,...">ipc::transport::error</a>, and essentially all the notes in that doc header and otherwise within that namespace apply equally here. Therefore please:</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceipc_1_1transport_1_1error.html" title="Namespace containing the ipc::transport module&#39;s extension of boost.system error conventions,...">ipc::transport::error</a> documentation; notes therein (such as to-dos) likely apply here equally. </dd></dl>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a0708d4bec9ae853f4d7e3d7822fc8f2f" name="a0708d4bec9ae853f4d7e3d7822fc8f2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0708d4bec9ae853f4d7e3d7822fc8f2f">&#9670;&nbsp;</a></span>Code</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">enum class <a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2f">ipc::session::error::Code</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>All possible errors returned (via <code>Error_code</code> arguments) by <a class="el" href="namespaceipc_1_1session.html" title="Flow-IPC module providing the broad lifecycle and shared-resource organization – via the session conc...">ipc::session</a> functions/methods <em>outside of</em> <a class="el" href="namespaceipc_1_1transport.html" title="Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) betwe...">ipc::transport</a>-triggered errors involved in transport involved in doing session-related work; and possibly system-triggered errors. </p>
<p >All notes from <a class="el" href="namespaceipc_1_1transport_1_1error.html#adfef15ef4e76cc55d652fbd9c2797297" title="All possible errors returned (via Error_code arguments) by ipc::transport functions/methods outside o...">transport::error::Code</a> doc header apply here. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a0708d4bec9ae853f4d7e3d7822fc8f2fac416e988563e44bf15fc6a81743eef53" name="a0708d4bec9ae853f4d7e3d7822fc8f2fac416e988563e44bf15fc6a81743eef53"></a>S_INVALID_ARGUMENT&#160;</td><td class="fielddoc"><p >User called an API with 1 or more arguments against the API spec. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0708d4bec9ae853f4d7e3d7822fc8f2fafe29343445a7bf167cc186a44bd2c6ed" name="a0708d4bec9ae853f4d7e3d7822fc8f2fafe29343445a7bf167cc186a44bd2c6ed"></a>S_OBJECT_SHUTDOWN_ABORTED_COMPLETION_HANDLER&#160;</td><td class="fielddoc"><p >Async completion handler is being called prematurely, because underlying object is shutting down, as user desires. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0708d4bec9ae853f4d7e3d7822fc8f2fa486f5607320d062fe89e559a1e7856b2" name="a0708d4bec9ae853f4d7e3d7822fc8f2fa486f5607320d062fe89e559a1e7856b2"></a>S_CLIENT_NAMESPACE_STORE_BAD_FORMAT&#160;</td><td class="fielddoc"><p ><a class="el" href="classipc_1_1session_1_1Session.html" title="A documentation-only concept defining the local side of an IPC conversation (session) with another en...">Session</a> master channel: log-in as client: The Client Namespace Store (CNS) file (a/k/a PID file) lacks leading newline-terminated line with numeric PID. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0708d4bec9ae853f4d7e3d7822fc8f2fa866090a4d042120126722b4daf1ecc33" name="a0708d4bec9ae853f4d7e3d7822fc8f2fa866090a4d042120126722b4daf1ecc33"></a>S_CLIENT_MASTER_LOG_IN_RESPONSE_BAD&#160;</td><td class="fielddoc"><p ><a class="el" href="classipc_1_1session_1_1Session.html" title="A documentation-only concept defining the local side of an IPC conversation (session) with another en...">Session</a> master channel: log-in as client: received log-in response is not the expected internal message. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0708d4bec9ae853f4d7e3d7822fc8f2faa195e468548ba9602c27590f2d6d49f0" name="a0708d4bec9ae853f4d7e3d7822fc8f2faa195e468548ba9602c27590f2d6d49f0"></a>S_SERVER_MASTER_LOG_IN_REQUEST_CLIENT_APP_DISALLOWED_OR_UNKNOWN&#160;</td><td class="fielddoc"><p ><a class="el" href="classipc_1_1session_1_1Session.html" title="A documentation-only concept defining the local side of an IPC conversation (session) with another en...">Session</a> master channel: log-in as server: client identifies self as unknown client-app or one that is not registered as an allowed partner to this server-app. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0708d4bec9ae853f4d7e3d7822fc8f2fa3f305ed5a242f067c9116216c0674264" name="a0708d4bec9ae853f4d7e3d7822fc8f2fa3f305ed5a242f067c9116216c0674264"></a>S_SERVER_MASTER_LOG_IN_REQUEST_CLIENT_APP_INCONSISTENT_CREDS&#160;</td><td class="fielddoc"><p ><a class="el" href="classipc_1_1session_1_1Session.html" title="A documentation-only concept defining the local side of an IPC conversation (session) with another en...">Session</a> master channel: log-in as server: client application-level process credentials (UID, etc.) do not match the registered values and/or the OS-reported client peer values from socket stream. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0708d4bec9ae853f4d7e3d7822fc8f2fa2c8c27c65ff6234220a84f96de8a1870" name="a0708d4bec9ae853f4d7e3d7822fc8f2fa2c8c27c65ff6234220a84f96de8a1870"></a>S_SESSION_OPEN_CHANNEL_REMOTE_PEER_REJECTED_PASSIVE_OPEN&#160;</td><td class="fielddoc"><p ><a class="el" href="classipc_1_1session_1_1Session.html" title="A documentation-only concept defining the local side of an IPC conversation (session) with another en...">Session</a> channel opening: User code chose to reject all passive-open requests. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0708d4bec9ae853f4d7e3d7822fc8f2fa10d32cf1382fb003f09a6df2da408574" name="a0708d4bec9ae853f4d7e3d7822fc8f2fa10d32cf1382fb003f09a6df2da408574"></a>S_SESSION_OPEN_CHANNEL_SERVER_CANNOT_PROCEED_RESOURCE_UNAVAILABLE&#160;</td><td class="fielddoc"><p ><a class="el" href="classipc_1_1session_1_1Session.html" title="A documentation-only concept defining the local side of an IPC conversation (session) with another en...">Session</a> channel opening: Server peer is responsible for low-level resource acquisition but failed to do so. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0708d4bec9ae853f4d7e3d7822fc8f2fa7d85b87223a9b277b8875c1f7971d6ad" name="a0708d4bec9ae853f4d7e3d7822fc8f2fa7d85b87223a9b277b8875c1f7971d6ad"></a>S_SESSION_OPEN_CHANNEL_ACTIVE_TIMEOUT&#160;</td><td class="fielddoc"><p ><a class="el" href="classipc_1_1session_1_1Session.html" title="A documentation-only concept defining the local side of an IPC conversation (session) with another en...">Session</a> channel opening: Other peer must reply quickly enough as-if non-blocking but did not do so in time. </p>
<p ><a class="el" href="classipc_1_1session_1_1Session.html" title="A documentation-only concept defining the local side of an IPC conversation (session) with another en...">Session</a> continues; this is not a fatal error. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0708d4bec9ae853f4d7e3d7822fc8f2fa7300721595cc25baa9a9e43bd76296aa" name="a0708d4bec9ae853f4d7e3d7822fc8f2fa7300721595cc25baa9a9e43bd76296aa"></a>S_MUTEX_BIPC_MISC_LIBRARY_ERROR&#160;</td><td class="fielddoc"><p >Low-level boost.ipc.mutex: boost.interprocess emitted miscellaneous library exception sans a system code; a WARNING message at throw-time should contain all possible details. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0708d4bec9ae853f4d7e3d7822fc8f2fa8fe83fc1ea258698473af610c0023a9d" name="a0708d4bec9ae853f4d7e3d7822fc8f2fa8fe83fc1ea258698473af610c0023a9d"></a>S_SERVER_MASTER_POST_LOG_IN_SEND_FAILED_MISC&#160;</td><td class="fielddoc"><p ><a class="el" href="classipc_1_1session_1_1Session.html" title="A documentation-only concept defining the local side of an IPC conversation (session) with another en...">Session</a> master channel: post-log-in setup (such as SHM setup): send failed because channel hosed around that time. </p>
<p >Timing was such that exact reason for this could not be obtained, but logs will show it. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0708d4bec9ae853f4d7e3d7822fc8f2fac734bd48bbfe30867f627363a8d5afc4" name="a0708d4bec9ae853f4d7e3d7822fc8f2fac734bd48bbfe30867f627363a8d5afc4"></a>S_SERVER_MASTER_LOG_IN_REQUEST_CONFIG_MISMATCH&#160;</td><td class="fielddoc"><p ><a class="el" href="classipc_1_1session_1_1Session.html" title="A documentation-only concept defining the local side of an IPC conversation (session) with another en...">Session</a> master channel: log-in as server: opposing client's compile-time type config differs from local server's counterpart config; did you use the proper Server/Client_session paired templates and mutually equal template parameters? </p>
</td></tr>
<tr><td class="fieldname"><a id="a0708d4bec9ae853f4d7e3d7822fc8f2fa5c437fa266aea0c8e2b348ee84dd61fa" name="a0708d4bec9ae853f4d7e3d7822fc8f2fa5c437fa266aea0c8e2b348ee84dd61fa"></a>S_RESOURCE_OWNER_UNEXPECTED&#160;</td><td class="fielddoc"><p >A resource in the file system (file, SHM pool, MQ, etc.) has or could have unexpected owner; <a class="el" href="namespaceipc_1_1session.html" title="Flow-IPC module providing the broad lifecycle and shared-resource organization – via the session conc...">ipc::session</a> may emit this when acquiring resources and/or opening session if the server process is not running as the configured user, or a previous iteration was not running as that user. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0708d4bec9ae853f4d7e3d7822fc8f2fa24eaed39f149e32f6ceaad54d24f8759" name="a0708d4bec9ae853f4d7e3d7822fc8f2fa24eaed39f149e32f6ceaad54d24f8759"></a>S_SESSION_FINISHED&#160;</td><td class="fielddoc"><p >The opposing end of the session in question has been closed gracefully by the user invoking the end-session API. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0708d4bec9ae853f4d7e3d7822fc8f2fa6fba12db09e5bebfaa04f6372c41c2cf" name="a0708d4bec9ae853f4d7e3d7822fc8f2fa6fba12db09e5bebfaa04f6372c41c2cf"></a>S_END_SENTINEL&#160;</td><td class="fielddoc"><p >SENTINEL: Not an error. This Code must never be issued by an error/success-emitting API; I/O use only. </p>
</td></tr>
</table>

<p class="definition">Definition at line <a class="el" href="ipc__session_2src_2ipc_2session_2error_8hpp_source.html#l00046">46</a> of file <a class="el" href="ipc__session_2src_2ipc_2session_2error_8hpp_source.html">error.hpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a9056f277d3ebf2778d06a2bb1f337c28" name="a9056f277d3ebf2778d06a2bb1f337c28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9056f277d3ebf2778d06a2bb1f337c28">&#9670;&nbsp;</a></span>make_error_code()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> ipc::session::error::make_error_code </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2f">Code</a>&#160;</td>
          <td class="paramname"><em>err_code</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Analogous to <a class="el" href="namespaceipc_1_1transport_1_1error.html#aa825718d46992654588588b09a0f1be6" title="Given a Code enum value, creates a lightweight Error_code (a/k/a boost.system error_code) representin...">transport::error::make_error_code()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">err_code</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

<p class="definition">Definition at line <a class="el" href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html#l00079">79</a> of file <a class="el" href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html">error.cpp</a>.</p>

<p class="reference">References <a class="el" href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html#l00038">ipc::session::error::Category::S_CATEGORY</a>.</p>

</div>
</div>
<a id="ad52f227f6cd73969ba6a898028264413" name="ad52f227f6cd73969ba6a898028264413"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad52f227f6cd73969ba6a898028264413">&#9670;&nbsp;</a></span>operator&lt;&lt;()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::ostream &amp; ipc::session::error::operator&lt;&lt; </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2f">Code</a>&#160;</td>
          <td class="paramname"><em>val</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Analogous to <a class="el" href="namespaceipc_1_1transport_1_1error.html#a4686a04e7ab89d4be42548cbb5b37975" title="Serializes a transport::error::Code to a standard output stream.">transport::error::operator&lt;&lt;()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td>See above. </td></tr>
    <tr><td class="paramname">val</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

<p class="definition">Definition at line <a class="el" href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html#l00195">195</a> of file <a class="el" href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html">error.cpp</a>.</p>

<p class="reference">References <a class="el" href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html#l00153">ipc::session::error::Category::code_symbol()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="namespaceipc_1_1session_1_1error_ad52f227f6cd73969ba6a898028264413_cgraph.svg" width="340" height="47"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>

</div>
</div>
<a id="a6041e74db4e17a75d8eed2541dc026f6" name="a6041e74db4e17a75d8eed2541dc026f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6041e74db4e17a75d8eed2541dc026f6">&#9670;&nbsp;</a></span>operator&gt;&gt;()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::istream &amp; ipc::session::error::operator&gt;&gt; </td>
          <td>(</td>
          <td class="paramtype">std::istream &amp;&#160;</td>
          <td class="paramname"><em>is</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2f">Code</a> &amp;&#160;</td>
          <td class="paramname"><em>val</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Analogous to <a class="el" href="namespaceipc_1_1transport_1_1error.html#a64595c41a5810937c39733230628c499" title="Deserializes a transport::error::Code from a standard input stream.">transport::error::operator&gt;&gt;()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">is</td><td>See above. </td></tr>
    <tr><td class="paramname">val</td><td>See above. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above. </dd></dl>

<p class="definition">Definition at line <a class="el" href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html#l00201">201</a> of file <a class="el" href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html">error.cpp</a>.</p>

<p class="reference">References <a class="el" href="ipc__session_2src_2ipc_2session_2error_8hpp_source.html#l00037">S_CODE_LOWEST_INT_VALUE</a>, and <a class="el" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa6fba12db09e5bebfaa04f6372c41c2cf">S_END_SENTINEL</a>.</p>

</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="aded1c40e8ae8a6ba0b9af47ab48a13bb" name="aded1c40e8ae8a6ba0b9af47ab48a13bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aded1c40e8ae8a6ba0b9af47ab48a13bb">&#9670;&nbsp;</a></span>S_CODE_LOWEST_INT_VALUE</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">constexpr int ipc::session::error::S_CODE_LOWEST_INT_VALUE = 1</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">constexpr</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Numeric value of the lowest Code. </p>

<p class="definition">Definition at line <a class="el" href="ipc__session_2src_2ipc_2session_2error_8hpp_source.html#l00037">37</a> of file <a class="el" href="ipc__session_2src_2ipc_2session_2error_8hpp_source.html">error.hpp</a>.</p>

<p class="reference">Referenced by <a class="el" href="ipc__session_2src_2ipc_2session_2error_8cpp_source.html#l00201">operator&gt;&gt;()</a>.</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:39 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
